home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / spitfire / sf322.zip / SFNODE.ZIP / SFNODE.DOC next >
Text File  |  1992-03-20  |  25KB  |  556 lines

  1.                                SFNODE.EXE
  2.                                Version 1.2
  3.                     Copyright (C) By Mike Woltz 1990-92
  4.                            Buffalo Creek Software    
  5.                                 A Member Of
  6.                   The Association Of Shareware Professionals
  7.                              
  8.     
  9.     
  10.     INTRODUCTION
  11.     ------------
  12.                          
  13.        SFNODE.EXE is a companion utility for SPITFIRE Bulletin Board
  14.     System software and will allow a number of configuration options
  15.     to be set outside the SPITFIRE program.  When using SFNODE.EXE's
  16.     command line parameters options, a number of options can now be
  17.     toggled on or off and values can be changed thru a scheduled event.
  18.     
  19.        SFNODE.EXE must reside in your main SPITFIRE directory where
  20.     your SFNODE.DAT exists.  If SFNODE.DAT is not found, SFNODE.EXE
  21.     provides you with the option of creating it.
  22.  
  23.  
  24.     MENU DRIVEN USAGE
  25.     -----------------
  26.  
  27.        When SFNODE.EXE is executed from the DOS prompt without any of
  28.     its optional command line parameters, a menu is displayed to the user 
  29.     showing the available options.  The menu will look like this:
  30.     
  31.     >>>>>>>>   MAIN MENU   <<<<<<<<
  32.     <D>... Display Command Line Usage       <T>... Toggle Switches
  33.     <M>.......... Modem Configuration       <F>........ File Paths
  34.     <C>................ Change Values       <Q>.............. Quit
  35.  
  36.     ENTER COMMAND - [D T M F C Q]?
  37.         
  38.     After making a selection, except Q to Quit, a window will open
  39.     up on the screen which displays all the features which can be
  40.     modified for the option you have selected.  As each window opens, 
  41.     the current setting will be shown to you for each feature.  Pressing 
  42.     the ESC key will always return to the previous screen.  Pressing Q 
  43.     will terminate program execution and you will be returned to the 
  44.     DOS prompt.  
  45.     
  46.     
  47.     DISPLAY COMMAND LINE USAGE
  48.     --------------------------        
  49.     
  50.        When this option is selected a window will open up displaying
  51.        the following command line usage parameters available with
  52.        SFNODE:
  53.        
  54.   /B[x] = Minimum Baud Rate Required
  55.   /C-   = Chat/Page Turned Off             /C+ = Chat/Page Turned On
  56.   /F-   = File Statistics Turned Off       /F+ = File Statistics Turned On
  57.   /M-   = Message Statistics Turned Off    /M+ = Message Statistics Turned On
  58.   /P-   = Configure As Public BBS          /P+ = Configure As Private BBS   
  59.   /S-   = Second Password Not Required     /S+ = Second Password Required
  60.   /U[x] = Upload Time Compensation.....[x] = Time Ratio
  61.  
  62.                     Press your favorite key to continue
  63.  
  64.        These options can be used as command line parameters for toggling
  65.        the selected features ON and OFF via SPITFIRE's scheduled events.  
  66.        More detailed information on how this is accomplished is discussed 
  67.        in the section, Usage As A Scheduled Event. 
  68.  
  69.  
  70.     MODEM CONFIGURATION
  71.     -------------------
  72.       
  73.        <S>  Serial Port Number
  74.        
  75.              Allows you to set the COMM port being used by your system.
  76.              SPITFIRE will access COMM ports 1, 2, 3 or 4.
  77.              
  78.        <B>  Baud Rate
  79.        
  80.              The baud rate is used to set the maximum speed your modem
  81.              is capable of.
  82.              
  83.        <I>  Modem Initialization String
  84.              
  85.              This option will allow you to alter the initialization 
  86.              string sent to the modem when SPITFIRE is booted up
  87.              and after each caller.  A growing list of known working
  88.              initialization strings and their corresponding modems
  89.              can be found in Appendix A of the SPITFIRE manual.
  90.         
  91.        <M>  Modem - Error Correction Type
  92.        
  93.              This option allows you to configure SPITFIRE for an error
  94.              checking modem if you have one available.  If you are 
  95.              using an error correction modem, be sure to turn this switch 
  96.              ON.  If you are using an error correction modem and this switch 
  97.              isn't turned on, when a caller logs on with an error correction 
  98.              modem, the Ymodem-g transfer protocols will not be available 
  99.              to the user.
  100.          
  101.        <E>  Error Correction Message
  102.         
  103.              This option allows you, if you have an error correction modem,
  104.              to specify the Modem Error Correction Message specific to your 
  105.              modem.  This is the code passed when one error correction modem
  106.              is connected to another error correction modem.  For instance,
  107.              the US Robotics HST modem uses ARQ.  Refer to your modem manual
  108.              for the code appropriate for your modem.
  109.  
  110.        <H>  Hardware Data Flow Control
  111.        
  112.              This switch toggles whether your a modem will automatically 
  113.              adjust to the baud rate of the incoming call rather than 
  114.              depending on the software to reset the baud rate of the comm 
  115.              port.  If the switch is set to Yes, then SPITFIRE will not 
  116.              adjust the comm port to the baud rate of the incoming call.  
  117.              If the switch is set to No, then SPITFIRE will adjust the 
  118.              comm port to the baud rate of the incoming call.
  119.             
  120.        <A>  Answer On What Ring
  121.  
  122.              The option allows you to set the number of rings that
  123.              will be permitted prior to the modem receiving the
  124.              incoming call.  Most often you will have this set to
  125.              1.  This can however be set higher if you wish to
  126.              increase the time prior to you modem receiving the
  127.              incoming call.
  128.  
  129.        <D>  Display Result Codes
  130.  
  131.              This option allows you to set whether the modem result
  132.              codes will be displayed to the screen.  If this option
  133.              is toggled off, no result codes will be displayed.  If
  134.              this option is toggled on, you will have verbose codes 
  135.              such as RING, CONNECT, CONNECT 1200, CONNECT 2400, etc.
  136.              displayed to your monitor screen.
  137.  
  138.        <L>  Break Length..(1000=1 Second)
  139.  
  140.              In the event SPITFIRE discovers an ~ in the modem
  141.              initialization string when initializing the modem, it
  142.              will pause a configured length of time before sending
  143.              the next character to the modem.  The configured 'Break
  144.              Length' represents the length of such pause.
  145.  
  146.  
  147.        <U>  Use High Speed Async Routines
  148.            
  149.              The high speed async routines within SPITFIRE seem to 
  150.              work fine with some systems and not with others.  You
  151.              simply need to turn this switch on and if your display
  152.              files are properly shown to your callers then all is
  153.              fine, otherwise, you will need to turn this switch off.
  154.  
  155.        <1>  Line COM1
  156.  
  157.              Allows the configuration of the IRQ SPITFIRE will use for
  158.              COMM port 1.  IRQ4 is standard for COM1.  Valid options
  159.              are 1 through 7.
  160.  
  161.        <2>  Line COM2
  162.  
  163.              Allows the configuration of the IRQ SPITFIRE will use for
  164.              COMM port 2.  IRQ3 is standard for COM2.  Valid options
  165.              are 1 through 7.
  166.  
  167.        <3>  Line COM3
  168.  
  169.              Allows the configuration of the IRQ SPITFIRE will use for
  170.              COMM port 3.  IRQ4 is standard for COM3.  Valid options
  171.              are 1 through 7.
  172.  
  173.        <4>  Line COM4
  174.  
  175.              Allows the configuration of the IRQ SPITFIRE will use for
  176.              COMM port 4.  IRQ3 is standard for COM4.  Valid options
  177.              are 1 through 7.
  178.  
  179.  
  180.     CHANGE VALUES
  181.     -------------
  182.  
  183.        <M>  Minimum Baud Required
  184.  
  185.              This option determines the minimum baud rate a caller
  186.              must use to access your BBS.  For instance, if this 
  187.              is set at 1200, a caller must connect at a baud rate 
  188.              between 1200 and the maximum baud rate of your BBS.
  189.              If a caller connects at a baud rate less than what 
  190.              is specified here, SF2SLOW.BBS will be displayed
  191.              and the caller will be logged off the system.
  192.  
  193.  
  194.        <N>  Node Number
  195.             
  196.             This option allows you to set the node number for your
  197.             SPITFIRE BBS system.  If you are operating a single node
  198.             BBS, this should be set to 1.  If you are operating a
  199.             multi-node BBS, this should be set to the appropriate
  200.             number for the specific node.  For instance, your main
  201.             node would be set to 1, your second node to 2, etc.
  202.  
  203.  
  204.        <P>  Private Node Security
  205.        
  206.             This option allows you to set the security required to
  207.             access this particular node on your BBS provided the node
  208.             is configured as private.  For instance, if you require a
  209.             security of 100 for the caller to have access to this node,
  210.             you would enter 100 here.  
  211.     
  212.     
  213.     TOGGLE SWITCHES
  214.     ---------------
  215.  
  216.        Selecting Toggle Switches will enable the Sysop to toggle the 
  217.     following SPITFIRE features:
  218.     
  219.        <A>  Printer On
  220.  
  221.              This allows you to toggle the printer ON/OFF.  Everything 
  222.              that is written to the CALLERS.LOG will also be sent to the 
  223.              printer if this toggle is on.  This is useful if you wish to 
  224.              retain a hard copy of your users' activities while online.  
  225.              Keep in mind that your printer must be turned on and ready 
  226.              for use.  SPITFIRE checks to determine if your printer is 
  227.              properly connected and ready for use and responds accordingly.
  228.        
  229.        <B>  Ansi/Graphics Available
  230.  
  231.              Toggles whether or not you wish to offer Ansi graphics.  If 
  232.              you wish to offer Ansi graphics, you must create .CLR files 
  233.              to match the display .BBS files you have: (i.e. -  ALL.BBS 
  234.              {non-Ansi} & ALL.CLR {Ansi Graphics}).  In order for you to 
  235.              see the Ansi Graphics locally, you must have DEVICE=ANSI.SYS 
  236.              in your CONFIG.SYS file. 
  237.           
  238.        
  239.        <C>  Private BBS
  240.  
  241.              Toggles whether you are going to configure this particular
  242.              node of your BBS as Public or Private.  If you toggle this 
  243.              as Private, then the user attempting to log on this node 
  244.              must be in the users file and must have the required 
  245.              security required for this node to be granted access.  If 
  246.              you have the system toggled as a Private BBS and a caller 
  247.              tries to log on as new user, then SPITFIRE display 
  248.              NEWUSER.BBS/.CLR (if found) and will then allow the 
  249.              caller to answer the new user questionnaire (if found).  
  250.              After the questionnaire is answered, then SPITFIRE will 
  251.              display PRIVATE.BBS/.CLR (if found) and log the caller off.
  252.              A note is left in HEYSYSOP.LOG advising that a new user 
  253.              attempted to log on.
  254.  
  255.  
  256.        <D>  Second Password Required
  257.        
  258.              Toggles password prompt.  If turned on, then after entering 
  259.              the first password, the system prompts the users for their 
  260.              birth dates. Should users not know their birth dates, the 
  261.              system will log them off.
  262.  
  263.  
  264.        <E>  Prompt/Page On
  265.        
  266.              By toggling this parameter <ON or OFF> the Sysop can decide
  267.              whether or not to be paged.  If the PAGE is ON, the words 
  268.              "PAGE ON" will appear on the top of your screen, provided you 
  269.              are using the split screen.  If the page is turned on and a 
  270.              user selects <P> for page, then the prompt bell will sound 
  271.              to notify you that a user wishes to chat with you.  
  272.              USERINIT.BBS/CLR will be displayed to the screen when you    
  273.              respond to the page.  If the PAGE is turned off and a user 
  274.              pages you, then SFPAGED.BBS/CLR will be displayed to the 
  275.              user and you will not be notified of the Page.
  276.        
  277.  
  278.        <F>  Direct Screen Writes
  279.  
  280.              Toggles the Direct Screen Write feature on and off.  If you 
  281.              are running SPITFIRE in a multi-tasking environment, you will 
  282.              want to set this to No to disable direct screen writing.  
  283.              Otherwise, you will want to set this to Yes because not using 
  284.              direct screen writes will slow the display speed down.
  285.        
  286.  
  287.        <G>  Prompt New Messages
  288.        
  289.                This feature allows the Sysop to determine whether callers 
  290.                will be prompted with their message statistics when logging 
  291.                on the BBS.  If this is set On, the caller will be notified 
  292.                upon log on of any new messages, number of received messages, 
  293.                messages sent by the caller and total number of messages on 
  294.                the BBS.  The SPITFIRE default is to have this set for On. 
  295.  
  296.  
  297.        <H>  Prompt New Uploads
  298.  
  299.              This feature allows the Sysop to designate whether callers 
  300.              will be prompted with new file statistics when logging on 
  301.              the BBS.  If this is set to On and the caller opts to list 
  302.              for new files when logging on the BBS, all new files will be 
  303.              listed.  In addition, SPITFIRE will inform the caller of the 
  304.              number of new files since last checked and the total amount
  305.              of downloadable files and bytes available on the system.  The
  306.              SPITFIRE default is to have this set for On.
  307.  
  308.  
  309.        <I>  Color Monitor
  310.  
  311.              Toggles whether your system is using a color monitor.
  312.        
  313.  
  314.     FILE PATHS
  315.     ----------   
  316.     
  317.        <A>  Work Files Path
  318.             C:\SF\WORK
  319.                 
  320.              Allows you to specify the directory in which the SPITFIRE 
  321.              Work Files reside.  All files which belong in the Work File 
  322.              Path are specified as such with a (WORK) in the SPITFIRE
  323.              manual.  Refer to the manual for further information.
  324.             
  325.        <B>  Display Files Path
  326.             C:\SF\DISPLAY
  327.                       
  328.              Allows you to specify the directory in which the SPITFIRE 
  329.              Display Files reside.  All files with a BBS or CLR extension 
  330.              are Display Files and should reside in the directory you 
  331.              designate here.  For more information refer to the 
  332.              SPITFIRE manual.
  333.             
  334.        <C>  External Protocol Path
  335.             C:\SF\EXTERNAL
  336.                          
  337.              Allows you to specify the directory from which you opt to 
  338.              run the SPITFIRE External Transfer Protocols.  All files 
  339.              which you are using to run the External Transfer Protocols 
  340.              must reside in the directory you designate here.  For more 
  341.              information on the External Transfer Protocol file path 
  342.              refer to the SPITFIRE manual.
  343.                         
  344.        <D>  Message File Path
  345.             C:\SF\MESSAGE
  346.             
  347.             Allows you to specify the directory from which all message
  348.             files are stored on the BBS.  All SFMSG<x>.DAT, SFMSG<x>.PTR,
  349.             SFMSG<x>.LMR and SFMSG<x>.IDX (where <x> represents the number
  350.             of the corresponding message conference) are stored in this
  351.             directory, the message file path.  For more information on 
  352.             the Message File Path refer to the SPITFIRE manual.
  353.  
  354.  
  355.     USAGE AS A SCHEDULED EVENT
  356.     --------------------------
  357.     
  358.        The inclusion of the command line usage parameters provide some
  359.     unique opportunities in the configuration of your SPITFIRE BBS.  A
  360.     brief description of each follows.    
  361.  
  362.  
  363.   /B[x] = Minimum Baud Rate Required
  364.      
  365.     Using the command line parameter /B1200 will prevent any calls with a
  366.     baud rate of less than 1200 to access to your BBS.  If SF2SLOW.BBS/CLR
  367.     exists, it will be displayed to the caller and the caller will be logged
  368.     off the BBS.  The /B0 will allow callers of any baud rate to access your
  369.     system.
  370.  
  371.  
  372.   /C-   = Chat/Page Turned Off               /C+ = Chat/Page Turned On
  373.   
  374.     Using the /C- will allow you to configure your BBS so that 
  375.     the ability for users to page you will be turned off.  If this
  376.     is set off, when a caller pages you SFPAGED.BBS/CLR will be
  377.     displayed if it is available.  The /C+ will turn on your ability
  378.     to be notified when you are paged by a caller.
  379.      
  380.           
  381.   /F-   = File Statistics Turned Off         /F+ = File Statistics Turned On
  382.   
  383.     Using the command line parameter /F- will allow you to configure your
  384.     BBS so that when a caller logs onto the BBS, he/she will not be prompted
  385.     to list new files.  By using the /F+, the caller when logging onto the
  386.     BBS will receive the prompt asking whether they wish to list new files
  387.     since last checked.
  388.     
  389.   /M-   = Message Statistics Turned Off     /M+ = Message Statistics Turned On
  390.  
  391.     Using the command line parameter /M- will allow you to configure your
  392.     BBS so that when a caller logs onto the BBS, he/she will not be prompted
  393.     to review message statistics.  By using the /M+, the caller, when logging 
  394.     onto the BBS, will be informed regarding any new messages, number of
  395.     received messages, messages sent by the caller and the total number of
  396.     messages available on the system.
  397.  
  398.  
  399.   /P-   = Configure As Public BBS            /P+ = Configure As Private BBS   
  400.   
  401.      The /P- configures your BBS as a Public BBS.  Provided you have
  402.      not passed the configured number of users allowed to access your
  403.      system, any new caller will be allowed to access your system.  The
  404.      /P+ configures your BBS as a Private BBS.  Then the user attempting
  405.      to log on must be in the users file to be granted access.  If a new
  406.      user attempts to log on, SPITFIRE will display NEWUSER.BBS/CLR (if
  407.      found) and will then have the caller answer the new user 
  408.      questionnaire (if found).  After the questionnaire is completed,
  409.      PRIVATE.BBS/CLR (if found) will be displayed and the caller is
  410.      logged off.  A note is left in the HEYSYSOP.LOG advising that a
  411.      a new user attempted to log on.
  412.      
  413.      
  414.   /S-   = Second Password Not Required       /S+ = Second Password Required
  415.   
  416.     The /S- configures your BBS so a second password is not required.
  417.     When a caller logs onto the BBS all that is required to gain
  418.     access is their first name, last name and password.  The /S+ 
  419.     configures your BBS so that the caller must also enter their
  420.     birthdate as a second password.
  421.       
  422.     
  423.   /U[x] = Upload Time Compensation...........[x] = Time Ratio
  424.   
  425.     The /U[x] allows you to configure the amount of time you wish to
  426.     compensate your callers for uploading files.  For instance, if
  427.     you wish to reward your callers extra time for uploading on a 
  428.     2 to 1 ratio, you would use /U2.  With this configuration, if
  429.     a caller used 5 minutes uploading a file, the caller would then
  430.     be compensated 10 additional minutes access on the BBS.
  431.   
  432.     
  433.     
  434.        Without the SFNODE utility you could only configure your BBS
  435.     to either allow 1200 baud callers or not to allow 1200 baud callers.  
  436.     Using SFNODE, it is possible to allow 1200 baud callers during the 
  437.     less active hours of BBS activity but then to once again lock them
  438.     out when the board is at its busiest.  Or perhaps you would like to
  439.     automatically require a second password every Saturday.  These are 
  440.     just a few of the possibilities SFNODE makes available using various
  441.     options of its command line parameters and SPITFIRE's scheduled events.  
  442.     
  443.        The procedure for using the command line parameters is the same
  444.     for each of these options.  The syntax for using the SFNODE with 
  445.     the command line parameters is to enter SFNODE, a blank space 
  446.     and then the command line parameter you wish to use for configuring 
  447.     your system.  For instance:
  448.     
  449.     SFNODE /S+     (This would require a second password be entered
  450.                     prior to the caller being granted access to the BBS)
  451.                        
  452.     This documentation will take you through the steps of toggling the 
  453.     1200 baud callers allowed On and Off as a scheduled event.  The 
  454.     remaining options can be set up using SPITFIRE's scheduled events 
  455.     in much the same way.                       
  456.          
  457.        To set up the 1200 baud callers allowed as a scheduled event, you 
  458.     may either use the ALT+E option from the SPITFIRE ready for use
  459.     prompt or by selecting <E>.... Events Menu from the Sysop utilities 
  460.     menu, followed by selecting <E>... Enable An Event from the Events
  461.     Menu.  For the purpose of explanation let's assume we are creating
  462.     event A, so choose A as the event to be created.  You are then prompted 
  463.     for the time the event will be performed.  Let's assume you will enter 
  464.     01:00.  Next, you are prompted for the day the event will be performed.  
  465.     Let's assume you wish to run the event daily, so enter 7.
  466.  
  467.        Following the same procedure a second event will need to be created
  468.    to toggle the 1200 baud callers allowed Off during the busiest hours of 
  469.    your BBS.  Again, let's assume your BBS gets its busiest around 6 pm.
  470.    Again, in the same manner, create an event only this time choose B as 
  471.    the event to be created.  You are then prompted for the time the event 
  472.    will be performed.  Enter 18:00.  You will want this event to run daily 
  473.    also, so once again, when prompted for the day the event will be 
  474.    performed, enter 7.   
  475.  
  476.        Now, using your favorite text editor, the SF.BAT file for Event A 
  477.     and Event B will look like this:
  478.              
  479.          :EVENT_A
  480.            REM Place Event Commands Here
  481.            GOTO LOOP
  482.          :EVENT_B
  483.            REM Place Event Commands Here
  484.            GOTO LOOP
  485.       
  486.        What is required next is to include all necessary DOS commands
  487.     which are needed to toggle the 1200 baud callers allowed On and Off
  488.     with the SFNODE utility and enter those in place of the "REM Place 
  489.     Event Commands Here".  A completed SF.BAT for Event A and Event B
  490.     would appear as:
  491.              
  492.          :EVENT_A
  493.            SFNODE /B1200
  494.            GOTO LOOP
  495.          :EVENT_B
  496.            SFNODE /B1201
  497.            GOTO LOOP
  498.  
  499.        With these events set up in the previously described manner, 
  500.     every morning at 1:00 am, EVENT_A will execute SFNODE to modify your 
  501.     SPITFIRE BBS configuration to allow 1200 baud callers on your system.  
  502.     Then each evening at 6:00 pm, EVENT-B will execute SFNODE to
  503.     modify your BBS configuration to not allow 1200 baud callers on
  504.     your BBS.
  505.     
  506.     
  507.     
  508.     IMPORTANT NOTE
  509.     --------------
  510.     
  511.        SFNODE should NOT be executed by jumping to DOS and modifying
  512.     parameters while SPITFIRE is in memory.  SPITFIRE holds the 
  513.     established settings in memory so before the changes can be 
  514.     effective, SPITFIRE must be re-booted.  You MUST exit out of 
  515.     SPITFIRE by pressing F10 or the changes you make will not be 
  516.     effective.
  517.  
  518.  
  519.     DISTRIBUTION
  520.     ------------
  521.  
  522.        SFNODE is distributed under the shareware concept.  You are
  523.     free to distribute the SFNODE program as long as it remains
  524.     unmodified and no fee is charged.  If you use this program and
  525.     find it beneficial a fee is required.  A $1.00 fee is required
  526.     of registered SPITFIRE sysops and a $5.00 fee is required of
  527.     all others.  This registration should be mailed to the below
  528.     listed address.
  529.  
  530.                       BUFFALO CREEK SOFTWARE
  531.                       ATTN: Mike Woltz
  532.                       913 - 39th Street
  533.                       West Des Moines, Iowa 50265
  534.     
  535.     
  536.     DISCLAIMER
  537.     ----------
  538.         
  539.        Mike Woltz and/or Buffalo Creek Software shall in no way be held 
  540.     responsible for any damage incurred while operating SFNODE.  All 
  541.     responsibility lies with the user of the software.
  542.  
  543.  
  544.        The documentation for SFNODE is contributed by Jacque Shipley
  545.     and The Mother Board BBS.  The shareware version of SPITFIRE 
  546.     and other SPITFIRE utilities are available for download from:
  547.  
  548.          Buffalo Creek's BBS              The Mother Board BBS
  549.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  550.            (515) 225-8496                    (515) 986-3464
  551.       19200/9600/2400/1200 Baud         19200/9600/2400/1200 Baud
  552.  
  553.     REVISION: SFNODE Version 1.2 - March 20, 1992
  554.        SFNODE was altered to comply with SPITFIRE v3.2.
  555.  
  556.